<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
<head>
<meta http-equiv="content-type" content="text/html; charset=ISO-8859-1" />
<title>DeltaCoverageReportCreator xref</title>
<link type="text/css" rel="stylesheet" href="../../../../../../stylesheet.css" />
</head>
<body>
<div id="overview"><a href="../../../../../../../../target/site/apidocs/org/apache/maven/plugin/deltacoverage/report/DeltaCoverageReportCreator.html">View Javadoc</a></div><pre>

<a name="1" href="#1">1</a>   <strong class="jxr_keyword">package</strong> org.apache.maven.plugin.deltacoverage.report;
<a name="2" href="#2">2</a>   
<a name="3" href="#3">3</a>   <strong class="jxr_keyword">import</strong> java.io.File;
<a name="4" href="#4">4</a>   <strong class="jxr_keyword">import</strong> java.io.FileWriter;
<a name="5" href="#5">5</a>   <strong class="jxr_keyword">import</strong> java.io.Writer;
<a name="6" href="#6">6</a>   <strong class="jxr_keyword">import</strong> java.util.HashMap;
<a name="7" href="#7">7</a>   <strong class="jxr_keyword">import</strong> java.util.List;
<a name="8" href="#8">8</a>   <strong class="jxr_keyword">import</strong> java.util.Map;
<a name="9" href="#9">9</a>   
<a name="10" href="#10">10</a>  <strong class="jxr_keyword">import</strong> org.apache.maven.plugin.deltacoverage.coverage.ModuleCoverage;
<a name="11" href="#11">11</a>  <strong class="jxr_keyword">import</strong> org.apache.maven.plugin.deltacoverage.util.ClassPathUtil;
<a name="12" href="#12">12</a>  
<a name="13" href="#13">13</a>  
<a name="14" href="#14">14</a>  <strong class="jxr_keyword">import</strong> freemarker.template.Configuration;
<a name="15" href="#15">15</a>  <strong class="jxr_keyword">import</strong> freemarker.template.DefaultObjectWrapper;
<a name="16" href="#16">16</a>  <strong class="jxr_keyword">import</strong> freemarker.template.Template;
<a name="17" href="#17">17</a>  
<a name="18" href="#18">18</a>  <em class="jxr_javadoccomment">/**</em>
<a name="19" href="#19">19</a>  <em class="jxr_javadoccomment"> * Generates report based on delta coverage. Uses Freemarker for report generation.</em>
<a name="20" href="#20">20</a>  <em class="jxr_javadoccomment"> * Reports are generated based on freemarker templates found in the package &lt;code&gt;org/apache/maven/plugin/deltacoverage/report/&lt;/code&gt; in class path.</em>
<a name="21" href="#21">21</a>  <em class="jxr_javadoccomment"> * To create new type of report, simply add a new template. </em>
<a name="22" href="#22">22</a>  <em class="jxr_javadoccomment"> * Note: </em>
<a name="23" href="#23">23</a>  <em class="jxr_javadoccomment"> * &lt;li&gt;The report name is derived from the template name (by simply removing the &lt;code&gt;.ftl&lt;/code&gt; template extension)&lt;/li&gt;</em>
<a name="24" href="#24">24</a>  <em class="jxr_javadoccomment"> * &lt;li&gt;Relative path to existing code coverage reports is available as variable &lt;code&gt;relativeCoveragePath&lt;/code&gt;. </em>
<a name="25" href="#25">25</a>  <em class="jxr_javadoccomment"> * This can be used to create links to existing coverage reports from the delta coverage report&lt;/li&gt;</em>
<a name="26" href="#26">26</a>  <em class="jxr_javadoccomment"> * </em>
<a name="27" href="#27">27</a>  <em class="jxr_javadoccomment"> * @author Abhijeet_Kesarkar</em>
<a name="28" href="#28">28</a>  <em class="jxr_javadoccomment"> *</em>
<a name="29" href="#29">29</a>  <em class="jxr_javadoccomment"> */</em>
<a name="30" href="#30">30</a>  <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">class</strong> <a href="../../../../../../org/apache/maven/plugin/deltacoverage/report/DeltaCoverageReportCreator.html">DeltaCoverageReportCreator</a> {
<a name="31" href="#31">31</a>  
<a name="32" href="#32">32</a>  	<strong class="jxr_keyword">private</strong> <strong class="jxr_keyword">static</strong> <strong class="jxr_keyword">final</strong> String KEY_COVERAGE = <span class="jxr_string">"coverage"</span>;
<a name="33" href="#33">33</a>  	<strong class="jxr_keyword">private</strong> <strong class="jxr_keyword">static</strong> <strong class="jxr_keyword">final</strong> String KEY_RELATIVE_COVERAGE_PATH = <span class="jxr_string">"relativeCoveragePath"</span>;
<a name="34" href="#34">34</a>  	<strong class="jxr_keyword">private</strong> <strong class="jxr_keyword">static</strong> <strong class="jxr_keyword">final</strong> String TEMPLATE_SUFFIX = <span class="jxr_string">".ftl"</span>;
<a name="35" href="#35">35</a>  	<strong class="jxr_keyword">private</strong> <strong class="jxr_keyword">static</strong> <strong class="jxr_keyword">final</strong> String TEMPLATE_ROOT = <span class="jxr_string">"org/apache/maven/plugin/deltacoverage/report/"</span>;
<a name="36" href="#36">36</a>  	<strong class="jxr_keyword">private</strong> <strong class="jxr_keyword">static</strong> <a href="../../../../../../org/apache/maven/plugin/deltacoverage/report/DeltaCoverageReportCreator.html">DeltaCoverageReportCreator</a> INSTANCE;
<a name="37" href="#37">37</a>  	<strong class="jxr_keyword">private</strong> Configuration cfg;
<a name="38" href="#38">38</a>  
<a name="39" href="#39">39</a>  	<em class="jxr_javadoccomment">/**</em>
<a name="40" href="#40">40</a>  <em class="jxr_javadoccomment">	 * Constructor with initialization of freemarker configuration.</em>
<a name="41" href="#41">41</a>  <em class="jxr_javadoccomment">	 */</em>
<a name="42" href="#42">42</a>  	<strong class="jxr_keyword">private</strong> <a href="../../../../../../org/apache/maven/plugin/deltacoverage/report/DeltaCoverageReportCreator.html">DeltaCoverageReportCreator</a>() {
<a name="43" href="#43">43</a>  		cfg = <strong class="jxr_keyword">new</strong> Configuration();
<a name="44" href="#44">44</a>  		cfg.setClassForTemplateLoading(DeltaCoverageReportCreator.<strong class="jxr_keyword">class</strong>, <span class="jxr_string">""</span>);
<a name="45" href="#45">45</a>  		cfg.setObjectWrapper(<strong class="jxr_keyword">new</strong> DefaultObjectWrapper());
<a name="46" href="#46">46</a>  	}
<a name="47" href="#47">47</a>  
<a name="48" href="#48">48</a>  	<em class="jxr_javadoccomment">/**</em>
<a name="49" href="#49">49</a>  <em class="jxr_javadoccomment">	 * Provides access to the singleton instance</em>
<a name="50" href="#50">50</a>  <em class="jxr_javadoccomment">	 * @return singleton instance</em>
<a name="51" href="#51">51</a>  <em class="jxr_javadoccomment">	 */</em>
<a name="52" href="#52">52</a>  	<strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">static</strong> <a href="../../../../../../org/apache/maven/plugin/deltacoverage/report/DeltaCoverageReportCreator.html">DeltaCoverageReportCreator</a> getInstance() {
<a name="53" href="#53">53</a>  		<strong class="jxr_keyword">if</strong> (INSTANCE == <strong class="jxr_keyword">null</strong>) {
<a name="54" href="#54">54</a>  			INSTANCE = <strong class="jxr_keyword">new</strong> <a href="../../../../../../org/apache/maven/plugin/deltacoverage/report/DeltaCoverageReportCreator.html">DeltaCoverageReportCreator</a>();
<a name="55" href="#55">55</a>  		}
<a name="56" href="#56">56</a>  		<strong class="jxr_keyword">return</strong> INSTANCE;
<a name="57" href="#57">57</a>  	}
<a name="58" href="#58">58</a>  
<a name="59" href="#59">59</a>  	<em class="jxr_javadoccomment">/**</em>
<a name="60" href="#60">60</a>  <em class="jxr_javadoccomment">	 * Generates reports for the specified delta coverage. The reports are generated in the</em>
<a name="61" href="#61">61</a>  <em class="jxr_javadoccomment">	 * specified &lt;code&gt;reportDir&lt;/code&gt;. Relative path to existing code coverage reports is available </em>
<a name="62" href="#62">62</a>  <em class="jxr_javadoccomment">	 * as variable &lt;code&gt;relativeCoveragePath&lt;/code&gt;. This can be used to create links to existing coverage reports </em>
<a name="63" href="#63">63</a>  <em class="jxr_javadoccomment">	 * from the delta coverage report.</em>
<a name="64" href="#64">64</a>  <em class="jxr_javadoccomment">	 * </em>
<a name="65" href="#65">65</a>  <em class="jxr_javadoccomment">	 * @param deltaCoverage {@link ModuleCoverage} instance indicating the delta coverage.</em>
<a name="66" href="#66">66</a>  <em class="jxr_javadoccomment">	 * @param reportDir folder in which report will be generated</em>
<a name="67" href="#67">67</a>  <em class="jxr_javadoccomment">	 * @param coverageDir folder containing existing coverage reports</em>
<a name="68" href="#68">68</a>  <em class="jxr_javadoccomment">	 * @throws Exception in case of IO error</em>
<a name="69" href="#69">69</a>  <em class="jxr_javadoccomment">	 */</em>
<a name="70" href="#70">70</a>  	<strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">void</strong> createReport(<a href="../../../../../../org/apache/maven/plugin/deltacoverage/coverage/ModuleCoverage.html">ModuleCoverage</a> deltaCoverage, File reportDir, File coverageDir) <strong class="jxr_keyword">throws</strong> Exception{
<a name="71" href="#71">71</a>  
<a name="72" href="#72">72</a>  		List&lt;String&gt; templateNames = ClassPathUtil.getTemplateNames(TEMPLATE_ROOT, TEMPLATE_SUFFIX);
<a name="73" href="#73">73</a>  
<a name="74" href="#74">74</a>  		<strong class="jxr_keyword">for</strong> (String templateName : templateNames) {
<a name="75" href="#75">75</a>  
<a name="76" href="#76">76</a>  			Writer out = <strong class="jxr_keyword">new</strong> FileWriter(<strong class="jxr_keyword">new</strong> File(reportDir, getReportName(templateName)));
<a name="77" href="#77">77</a>  			Map&lt;String, Object&gt; map = <strong class="jxr_keyword">new</strong> HashMap&lt;String, Object&gt;();
<a name="78" href="#78">78</a>  			map.put(KEY_COVERAGE, deltaCoverage);
<a name="79" href="#79">79</a>  			map.put(KEY_RELATIVE_COVERAGE_PATH, getRelativePath(coverageDir, reportDir));
<a name="80" href="#80">80</a>  
<a name="81" href="#81">81</a>  			Template template = cfg.getTemplate(templateName);
<a name="82" href="#82">82</a>  			template.process(map, out);
<a name="83" href="#83">83</a>  
<a name="84" href="#84">84</a>  		}
<a name="85" href="#85">85</a>  
<a name="86" href="#86">86</a>  	}
<a name="87" href="#87">87</a>  
<a name="88" href="#88">88</a>  	<em class="jxr_javadoccomment">/**</em>
<a name="89" href="#89">89</a>  <em class="jxr_javadoccomment">	 * Calculates relative path between coverage dir and report dir.</em>
<a name="90" href="#90">90</a>  <em class="jxr_javadoccomment">	 * e.g. if coverage dir is &lt;code&gt;/x/y/site/coverage&lt;/code&gt; and report dir is &lt;code&gt;/x/y/target&lt;/code&gt;,</em>
<a name="91" href="#91">91</a>  <em class="jxr_javadoccomment">	 * then this will return &lt;code&gt;../site/coverage/&lt;/code&gt;</em>
<a name="92" href="#92">92</a>  <em class="jxr_javadoccomment">	 * </em>
<a name="93" href="#93">93</a>  <em class="jxr_javadoccomment">	 * @param coverageDir folder containing to existing coverage reports</em>
<a name="94" href="#94">94</a>  <em class="jxr_javadoccomment">	 * @param reportDir folder in which reports will be generated</em>
<a name="95" href="#95">95</a>  <em class="jxr_javadoccomment">	 * @return relative path between reportDir and coverageDir</em>
<a name="96" href="#96">96</a>  <em class="jxr_javadoccomment">	 */</em>
<a name="97" href="#97">97</a>  	String getRelativePath(File coverageDir, File reportDir) {
<a name="98" href="#98">98</a>  		String[] reportPaths = reportDir.getAbsolutePath().split(<span class="jxr_string">"&#92;&#92;"</span> + File.separator);
<a name="99" href="#99">99</a>  		String[] coveragePaths = coverageDir.getAbsolutePath().split(<span class="jxr_string">"&#92;&#92;"</span> + File.separator);
<a name="100" href="#100">100</a> 		StringBuilder builder = <strong class="jxr_keyword">new</strong> StringBuilder(<span class="jxr_string">"."</span>);
<a name="101" href="#101">101</a> 		<strong class="jxr_keyword">int</strong> i = 0;
<a name="102" href="#102">102</a> 		<strong class="jxr_keyword">boolean</strong> different = false;
<a name="103" href="#103">103</a> 		<strong class="jxr_keyword">for</strong> (; i &lt; coveragePaths.length; i++) {
<a name="104" href="#104">104</a> 			<strong class="jxr_keyword">if</strong> (i &gt;= reportPaths.length || !coveragePaths[i].equals(reportPaths[i])) {
<a name="105" href="#105">105</a> 				<strong class="jxr_keyword">for</strong> (<strong class="jxr_keyword">int</strong> j = i; j &lt; reportPaths.length; j++) {
<a name="106" href="#106">106</a> 					builder.append(File.separator + <span class="jxr_string">".."</span>);
<a name="107" href="#107">107</a> 				}
<a name="108" href="#108">108</a> 				<strong class="jxr_keyword">for</strong> (<strong class="jxr_keyword">int</strong> j = i; j &lt; coveragePaths.length; j++) {
<a name="109" href="#109">109</a> 					builder.append(File.separator + coveragePaths[j]);
<a name="110" href="#110">110</a> 				}
<a name="111" href="#111">111</a> 				different = <strong class="jxr_keyword">true</strong>;
<a name="112" href="#112">112</a> 				<strong class="jxr_keyword">break</strong>;
<a name="113" href="#113">113</a> 			}
<a name="114" href="#114">114</a> 		}
<a name="115" href="#115">115</a> 		<strong class="jxr_keyword">if</strong> (i &lt; reportPaths.length &amp;&amp; !different) {
<a name="116" href="#116">116</a> 			<strong class="jxr_keyword">for</strong> (<strong class="jxr_keyword">int</strong> j = i; j &lt; reportPaths.length; j++) {
<a name="117" href="#117">117</a> 				builder.append(File.separator + <span class="jxr_string">".."</span>);
<a name="118" href="#118">118</a> 			}
<a name="119" href="#119">119</a> 		}
<a name="120" href="#120">120</a> 		builder.append(File.separator);
<a name="121" href="#121">121</a> 
<a name="122" href="#122">122</a> 		<strong class="jxr_keyword">return</strong> builder.toString();
<a name="123" href="#123">123</a> 	}
<a name="124" href="#124">124</a> 
<a name="125" href="#125">125</a> 	<em class="jxr_javadoccomment">/**</em>
<a name="126" href="#126">126</a> <em class="jxr_javadoccomment">	 * Extracts report name from template name by simply removing the &lt;code&gt;.ftl&lt;/code&gt; template extension.</em>
<a name="127" href="#127">127</a> <em class="jxr_javadoccomment">	 * </em>
<a name="128" href="#128">128</a> <em class="jxr_javadoccomment">	 * @param templateName template file name like &lt;code&gt;DeltaCodeCoverage.html.ftl&lt;/code&gt; </em>
<a name="129" href="#129">129</a> <em class="jxr_javadoccomment">	 * @return report name like &lt;code&gt;DeltaCodeCoverage.html&lt;/code&gt; </em>
<a name="130" href="#130">130</a> <em class="jxr_javadoccomment">	 */</em>
<a name="131" href="#131">131</a> 	<strong class="jxr_keyword">private</strong> String getReportName(String templateName) {
<a name="132" href="#132">132</a> 		String reportName = <strong class="jxr_keyword">null</strong>;
<a name="133" href="#133">133</a> 		File file = <strong class="jxr_keyword">new</strong> File(templateName);
<a name="134" href="#134">134</a> 		reportName = file.getName();
<a name="135" href="#135">135</a> 		<strong class="jxr_keyword">return</strong> reportName.replace(TEMPLATE_SUFFIX, <span class="jxr_string">""</span>);
<a name="136" href="#136">136</a> 	}
<a name="137" href="#137">137</a> 
<a name="138" href="#138">138</a> }
</pre>
<hr/><div id="footer">This page was automatically generated by <a href="http://maven.apache.org/">Maven</a></div></body>
</html>

